Assorted date and time procedures.
Include File: AfxTime.inc.
| Name | Description |
|---|---|
| AfxAstroDay | Returns the Astronomical Day for any given date. |
| AfxAstroDayOfWeek | Calculates the day of the week, Sunday through Monday, of a given date. |
| AfxDateAddDays | Adds the specified number of days to a given date. |
| AfxDateDiff | Calculates the days of difference between two dates. |
| AfxDayOfYear | Returns the day of the year, where Jan 1 is the first day of the year. |
| AfxDaysBetween | Returns the number of days between two given dates. |
| AfxDaysInMonth | Returns the number of days in the specified month/year. |
| AfxDaysInYear | Returns the number of days in the specified year. |
| AfxFileTimeToDateStr | Converts a FILETIME type to a string containing the date based on the specified mask, e.g. "dd-MM-yyyy". |
| AfxFileTimeToTime64 | Converts a FILETIME to a __time64_t (LONGLONG) value. |
| AfxFileTimeToTimeStr | Converts a FILETIME type to a string containing the time based on the specified mask, e.g. "hh':'mm':'ss". |
| AfxGmtTime64 | Converts a FILETIME to a __time64_t (LONGLONG) value. |
| AfxGregorianToJulian | Converts a Gregorian date to a Julian date. The year must be a 4 digit year. |
| AfxIsFirstDayOfMonth | Returns TRUE if today is the first day of the month; False, otherwise. |
| AfxIsLastDayOfMonth | Returns TRUE if today is the last day of the month; False, otherwise. |
| AfxIsLeapYear | Determines if a given year is a leap year or not. |
| AfxIsValidFILETIME | Checks if a FILETIME is valid. |
| AfxJulianDayOfWeek | Given a Julian date, returns the day of week. |
| AfxJulianToGregorian | Converts a Julian date to a Gregorian date. |
| AfxJulianToGregorianStr | Converts a Julian date to a Gregorian date based on the specified mask, e.g. "dd-MM-yyyy". |
| AfxLocalDateStr | Retuns the current local date based on the specified mask, e.g. "dd-MM-yyyy". |
| AfxLocalDay | Returns the current local day. The valid values are 1 through 31. |
| AfxLocalDayName | Returns the localized name of today. |
| AfxLocalDayOfWeek | Returns the current day of week. It is a numeric value in the range of 0-6 representing Sunday through Saturday: 0 = Sunday, 1 = Monday, etc. |
| AfxLocalDayOfWeekName | Returns the localized name of the day of the week. |
| AfxLocalDayOfWeekShortName | Returns the localized short name of the day of the week. |
| AfxLocalDayShortName | Returns the localized short name of today. |
| AfxLocalFileTime | Returns the current local time as a FILETIME structure. |
| AfxLocalHour | Returns the current local hour. The valid values are 0 through 23. |
| AfxLocalMonth | Returns the current local month. The valid values are 1 thorugh 12 (1 = January, etc.). |
| AfxLocalMonthName | Returns the localized name of today's local month. |
| AfxLocalShortMonthName | Returns the localized short name of today's local month. |
| AfxLocalSystemTime | Returns the current local time as a SYSTEMTIME structure. |
| AfxLocalTime64 | Converts a FILETIME to a __time64_t (LONGLONG) value. |
| AfxLocalTimeStr | Retuns the current local time based on the specified mask, e.g. "hh':'mm':'ss". |
| AfxLocalVariantTime | Returns the local date and time as a DATE_ (double). |
| AfxLocalYear | Returns the current local year. The valid values are 1601 through 30827. |
| AfxLongDate | Returns the current date in long format. |
| AfxMakeTime64 | Converts the local time to a calendar value. |
| AfxMonthName | Returns the localized name of the specified month. |
| AfxQuadDateTime | Returns the current date and time as a QUAD (8 bytes). In Free Basic, a QUAD is an ULONGLONG. |
| AfxQuadDateToStr | Converts a date stored in a QUAD into a formatted date string. For example, to get the date string "Wed, Aug 31 94" use the following picture string: "ddd',' MMM dd yy". In Free Basic, a QUAD is an ULONGLONG. |
| AfxQuadTimeToStr | Converts a time stored in a QUAD into a formatted time string. For example, get the time string "11:29:40 PM" use the following picture string: "hh':'mm':'ss tt". In Free Basic, a QUAD is an ULONGLONG. |
| AfxShortDate | Returns the current date in short format. |
| AfxShortMonthName | Returns the localized short name of the specified month. |
| AfxSystemDay | Returns the current system day. The valid values are 1 through 31. |
| AfxSystemDayName | Returns the localized name of today. |
| AfxSystemDayOfWeek | Returns the current day of week. It is a numeric value in the range of 0-6 representing Sunday through Saturday: 0 = Sunday, 1 = Monday, etc. |
| AfxSystemDayShortName | Returns the localized short name of today. |
| AfxSystemFileTime | Returns the current system time as a FILETIME structure. |
| AfxSystemHour | Returns the current system hour. The valid values are 0 through 23. |
| AfxSystemMonth | Returns the current system month. The valid values are 1 thorugh 12 (1 = January, etc.). |
| AfxSystemMonthName | Returns the localized name of today's system month. |
| AfxSystemShortMonthName | Returns the localized short name of today's system month. |
| AfxSystemSystemTime | Returns the current system time as a SYSTEMTIME structure. |
| AfxSystemTimeToTime64 | Converts a system time to a __time64_t (LONGLONG). |
| AfxSystemTimeToDateStr | Converts a SYSTEMTIME type to a string containing the date based on the specified mask, e.g. "dd-MM-yyyy". |
| AfxSystemTimeToTimeStr | Converts a SYSTEMTIME type to a string containing the time based on the specified mask, e.g. "hh':'mm':'ss". |
| AfxSystemTimeToVariantTime | Converts a SYSTEMTIME to a DATE_ (double). |
| AfxSystemYear | Returns the current system year. The valid values are 1601 through 30827. |
| AfxTime64 | Returns the time as seconds elapsed since midnight, January 1, 1970. |
| AfxTime64ToFileTime | Converts a __time64_t (LONGLONG) value to a FILETIME structure. |
| AfxTime64ToSystemTime | Converts a __time64_t (LONGLONG) to a SYSTEMTIME structure. |
| AfxTimeZoneBias | Current bias for local time translation. The bias is the difference between Coordinated Universal Time (UTC) and local time. All translations between UTC and local time are based on the following formula: UTC = local time + bias. Units = minutes. |
| AfxTimeZoneDaylightBias | Bias value to be used during local time translations that occur during daylight saving time. This property is ignored if a value for the DaylightDay property is not supplied. The value of this property is added to the Bias property to form the bias used during daylight time. In most time zones, the value of this property is -60. Units = minutes. |
| AfxTimeZoneDaylightDay | DaylightDayOfWeek of the DaylightMonth when the transition from standard time to daylight saving time occurs on this operating system. |
| AfxTimeZoneDaylightDayOfWeek | Day of the week when the transition from standard time to daylight saving time occurs on an operating system. |
| AfxTimeZoneDaylightHour | Hour of the day when the transition from standard time to daylight saving time occurs on an operating system. |
| AfxTimeZoneDaylightMinute | Minute of of the DaylightHour when the transition from standard time to daylight saving time occurs on an operating system. |
| AfxTimeZoneDaylightMonth | Month when the transition from standard time to daylight saving time occurs on an operating system. |
| AfxTimeZoneDaylightName | A description for daylight saving time. For example, "EST" could indicate Eastern Standard Time. This string can be empty. |
| AfxTimeZoneId | Returns the time zone identifier. |
| AfxTimeZoneIsDaylightSavingTime | Indicates whether the the system is operating in the range covered by the DaylightDate member of the TIME_ZONE_INFORMATION structure. |
| AfxTimeZoneIsStandardSavingTime | Indicates whether the the system is operating in the range covered by the StandardDate member of the TIME_ZONE_INFORMATION structure. |
| AfxTimeZoneStandardDay | StandardDayOfWeek of the StandardMonth when the transition from daylight saving time to standard time occurs on an operating system. |
| AfxTimeZoneStandardDayOfWeek | Day of the week when the transition from daylight saving time to standard time occurs on an operating system. |
| AfxTimeZoneStandardHour | Hour of the day when the transition from daylight saving time to standard time occurs on an operating system. |
| AfxTimeZoneStandardMinute | Minute of of the StandardHour when the transition from standard time to daylight saving time occurs on an operating system. |
| AfxTimeZoneStandardMonth | Month when the transition from daylight saving time to standard time occurs on an operating system. |
| AfxTimeZoneStandardName | A description for standard time. For example, "EST" could indicate Eastern Standard Time. This string can be empty. |
| AfxVariantDateTimeToStr | Converts a DATE_ type to a string. |
| AfxVariantDateToStr | Converts a DATE_ type to a string containing only the date. |
| AfxVariantTimeToStr | Converts a DATE_ type to a string containing only the time. |
| AfxVariantTimeToSystemTime | Converts a DATE_ (double) to a SYSTEMTIME. |
| AfxWeekNumber | Returns the week number for a given date. The year must be a 4 digit year. |
| AfxWeekOne | Returns the first day of the first week of a year. The year must be a 4 digit year. |
| AfxWeeksInMonth | Returns the number of weeks in the specified month. Will be 4 or 5. |
| AfxWeeksInYear | Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. |
Returns the Astronomical Day for any given date.
FUNCTION AfxAstroDay (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay | A day number (1-31). |
| nMonth | A month number (1-12). |
| nYear | A four digit year. |
The astronomical day.
Among other things, can be used to find the number of days between any two dates, e.g.:
PRINT AfxAstroDay(1, 3, -12400) - AfxAstroDay(28, 2, -12400) ' Prints 2
PRINT AfxAstroDay(1, 3, 12000) - AfxAstroDay(28, 2, -12000) ' Prints 8765822
PRINT AfxAstroDay(28, 2, 1902) - AfxAstroDay(1, 3, 1898) ' Prints 1459 days
Calculates the day of the week, Sunday through Monday, of a given date.
FUNCTION AfxAstroDayOfWeek (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay | A day number (1-31). |
| nMonth | A month number (1-12). |
| nYear | A four digit year. |
A number between 0-6, where 0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday.
Adds the specified number of days to a given date.
FUNCTION AfxDateAddDays (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, BYVAL nYear AS LONG, _
BYVAL nDays AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay | A day number (1-31). |
| nMonth | A month number (1-12). |
| nYear | A four digit year. |
| nDays | The number of days to add (or subtract, if it is negative). |
The new date in Julian format. To convert it to Gregorian, call functions such AfxJulianToGregorian or AfxJulianToGregorianStr.
Calculates the days of difference between two dates.
FUNCTION AfxDateDiff (BYVAL nDay1 AS LONG, BYVAL nMonth1 AS LONG, BYVAL nYear1 AS LONG, _
BYVAL nDay2 AS LONG, BYVAL nMonth2 AS LONG, BYVAL nYear2 AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay1 | A day number (1-31). |
| nMonth1 | A month number (1-12). |
| nYear1 | A four digit year. |
| nDay2 | A day number (1-31). |
| nMonth2 | A month number (1-12). |
| nYear2 | A four digit year. |
The days of difference between the two dates.
Returns the day of the year, where Jan 1 is the first day of the year.
FUNCTION AfxDayOfYear (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay | A day number (1-31). |
| nMonth | A month number (1-12). |
| nYear | A four digit year. |
The day of the year.
Returns the number of days between two given dates.
FUNCTION AfxDaysBetween (BYVAL nDay1 AS LONG, BYVAL nMonth1 AS LONG, BYVAL nYear1 AS LONG, _
BYVAL nDay2 AS LONG, BYVAL nMonth2 AS LONG, BYVAL nYear2 AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay1 | A day number (1-31). |
| nMonth1 | A month number (1-12). |
| nYear1 | A four digit year. |
| nDay2 | A day number (1-31). |
| nMonth2 | A month number (1-12). |
| nYear2 | A four digit year. |
The number of days.
Returns the number of days in the specified month/year.
FUNCTION AfxDaysInMonth (BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nMonth | A month ordinal number (1-12). |
| nYear | A four digit year. |
The number of days in the specified month/year.
Returns the number of days in the specified year.
FUNCTION AfxDaysInYear (BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nYear | A four digit year. |
The number of days: 365 (not leap year) or 366 (leap year).
Converts a FILETIME type to a string containing the date based on the specified mask, e.g. "dd-MM-yyyy".
FUNCTION AfxFileTimeToDateStr (BYREF ft AS FILETIME, BYREF wszMask AS WSTRING, _
BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| ft | A FILETIME structure. |
| wszMask | A picture string that is used to form the date. The format types "d", and "y" must be lowercase and the letter "M" must be uppercase. For example, to get the date string "Wed, Aug 31 94", the application uses the picture string "ddd',' MMM dd yy". |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
The following table defines the format types used to represent days.
| Format type | Meaning |
|---|---|
| d | Day of the month as digits without leading zeros for single-digit days. |
| dd | Day of the month as digits with leading zeros for single-digit days. |
| ddd | Abbreviated day of the week, for example, "Mon" in English (United States). |
| dddd | Day of the week. |
The following table defines the format types used to represent months.
| Format type | Meaning |
|---|---|
| M | Month as digits without leading zeros for single-digit months. |
| MM | Month as digits with leading zeros for single-digit months. |
| MMM | Abbreviated month, for example, "Nov" in English (United States). |
| MMMM | Month value, for example, "November" for English (United States), and "Noviembre" for Spanish (Spain). |
The following table defines the format types used to represent years.
| Format type | Meaning |
|---|---|
| y | Year represented only by the last digit. |
| yy | Year represented only by the last two digits. A leading zero is added for single-digit years. |
| yyyy | Year represented by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed. |
| yyyyy | Behaves identically to "yyyy". |
The formatted date.
Converts a FILETIME to a __time64_t (LONGLONG) value.
FUNCTION AfxFileTimeToTime64 (BYREF ft AS FILETIME) AS LONGLONG
| Parameter | Description |
|---|---|
| ft | A FILETIME structure. |
The converted time.
Converts a FILETIME type to a string containing the time based on the specified mask, e.g. "hh':'mm':'ss".
FUNCTION AfxFileTimeToTimeStr (BYREF ft AS FILETIME, BYREF wszMask AS WSTRING, _
BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| ft | A FILETIME structure. |
| wszMask | A picture string that is used to form the time. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
The application can use the following elements to construct a format picture string. If spaces are used to separate the elements in the format string, these spaces appear in the same location in the output string. The letters must be in uppercase or lowercase as shown, for example, "ss", not "SS". Characters in the format string that are enclosed in single quotation marks appear in the same location and unchanged in the output string.
| Picture | Meaning |
|---|---|
| h | Hours with no leading zero for single-digit hours; 12-hour clock |
| hh | Hours with leading zero for single-digit hours; 12-hour clock |
| H | Hours with no leading zero for single-digit hours; 24-hour clock |
| HH | Hours with leading zero for single-digit hours; 24-hour clock |
| m | Minutes with no leading zero for single-digit minutes |
| mm | Minutes with leading zero for single-digit minutes |
| s | Seconds with no leading zero for single-digit seconds |
| ss | Seconds with leading zero for single-digit seconds |
| t | One character time marker string, such as A or P |
| tt | Multi-character time marker string, such as AM or PM |
The formatted time.
Converts a FILETIME to a __time64_t (LONGLONG) value.
FUNCTION AfxGmtTime64 (BYVAL t64 AS LONGLONG) AS tm
| Parameter | Description |
|---|---|
| t64 | A __time64_t (LONGLONG) value. The time is represented as seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC). |
Returns a tm structure. The fields of the returned structure hold the evaluated value of the time argument in UTC rather than in local time.
The fields of the structure type tm store the following values, each of which is an int:
tm_sec : Seconds after minute (0 – 59).
tm_min : Minutes after hour (0 – 59).
tm_hour : Hours after midnight (0 – 23).
tm_mday : Day of month (1 – 31).
tm_mon : Month (0 – 11; January = 0).
tm_year : Year (current year minus 1900).
tm_wday : Day of week (0 – 6; Sunday = 0).
tm_yday : Day of year (0 – 365; January 1 = 0).
tm_isdst : Positive value if daylight saving time is in effect; 0 if daylight saving time is not in effect; negative value if status of daylight saving time is unknown.
Replacement for _gmtime64, not available in msvcrt.dll.
Converts a Gregorian date to a Julian date. The year must be a 4 digit year.
FUNCTION AfxGregorianToJulian (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay | A day number (1-31). |
| nMonth | A month number (1-12). |
| nYear | A four digit year. |
The converted date.
Returns TRUE if today is the first day of the month; False, otherwise.
FUNCTION AfxIsFirstDayOfMonth () AS BOOLEAN
Returns TRUE if today is the last day of the month; False, otherwise.
FUNCTION AfxIsLastDayOfMonth () AS BOOLEAN
Determines if a given year is a leap year or not.
FUNCTION AfxIsLeapYear (BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nYear | A four digit year. |
Checks if a FILETIME is valid.
FUNCTION AfxIsValidFILETIME (BYREF ft AS FILETIME) AS BOOLEAN
| Parameter | Description |
|---|---|
| ft | The FILETIME structure to check. |
Given a Julian date, returns the day of week.
FUNCTION AfxJulianDayOfWeek (BYVAL nJulian AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nJulian | The Julian date. |
A number between 0-6, where 0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday.
Converts a Julian date to a Gregorian date.
FUNCTION AfxJulianToGregorian (BYVAL nJulian AS LONG, BYVAL nDay AS LONG, _
BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nJulian | The Julian date. |
| nDay | Out. The day (1-31). |
| nMonth | Out. The month (1-12). |
| nYear | Out. The four digit year. |
Converts a Julian date to a Gregorian date based on the specified mask, e.g. "dd-MM-yyyy".
FUNCTION AfxJulianToGregorianStr (BYREF wszMask AS WSTRING, BYVAL nJulian AS LONG) AS CWSTR
| Parameter | Description |
|---|---|
| wszMask | A picture string that is used to form the date. The format types "d", and "y" must be lowercase and the letter "M" must be uppercase. For example, to get the date string "Wed, Aug 31 94", the application uses the picture string "ddd',' MMM dd yy". |
| nJulian | The Julian date. |
The following table defines the format types used to represent days.
| Format type | Meaning |
|---|---|
| d | Day of the month as digits without leading zeros for single-digit days. |
| dd | Day of the month as digits with leading zeros for single-digit days. |
| ddd | Abbreviated day of the week, for example, "Mon" in English (United States). |
| dddd | Day of the week. |
The following table defines the format types used to represent months.
| Format type | Meaning |
|---|---|
| M | Month as digits without leading zeros for single-digit months. |
| MM | Month as digits with leading zeros for single-digit months. |
| MMM | Abbreviated month, for example, "Nov" in English (United States). |
| MMMM | Month value, for example, "November" for English (United States), and "Noviembre" for Spanish (Spain). |
The following table defines the format types used to represent years.
| Format type | Meaning |
|---|---|
| y | Year represented only by the last digit. |
| yy | Year represented only by the last two digits. A leading zero is added for single-digit years. |
| yyyy | Year represented by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed. |
| yyyyy | Behaves identically to "yyyy". |
The formatted date.
Retuns the current local date based on the specified mask, e.g. "dd-MM-yyyy".
FUNCTION AfxLocalDateStr (BYREF wszMask AS WSTRING, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| wszMask | A picture string that is used to form the date. The format types "d", and "y" must be lowercase and the letter "M" must be uppercase. For example, to get the date string "Wed, Aug 31 94", the application uses the picture string "ddd',' MMM dd yy". |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
The following table defines the format types used to represent days.
| Format type | Meaning |
|---|---|
| d | Day of the month as digits without leading zeros for single-digit days. |
| dd | Day of the month as digits with leading zeros for single-digit days. |
| ddd | Abbreviated day of the week, for example, "Mon" in English (United States). |
| dddd | Day of the week. |
The following table defines the format types used to represent months.
| Format type | Meaning |
|---|---|
| M | Month as digits without leading zeros for single-digit months. |
| MM | Month as digits with leading zeros for single-digit months. |
| MMM | Abbreviated month, for example, "Nov" in English (United States). |
| MMMM | Month value, for example, "November" for English (United States), and "Noviembre" for Spanish (Spain). |
The following table defines the format types used to represent years.
| Format type | Meaning |
|---|---|
| y | Year represented only by the last digit. |
| yy | Year represented only by the last two digits. A leading zero is added for single-digit years. |
| yyyy | Year represented by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed. |
| yyyyy | Behaves identically to "yyyy". |
The current local date in string format.
Returns the current local day. The valid values are 1 through 31.
FUNCTION AfxLocalDay () AS WORD
Returns the current local day. The valid values are 1 through 31.
FUNCTION AfxLocalDayName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the current day of week. It is a numeric value in the range of 0-6 representing Sunday through Saturday: 0 = Sunday, 1 = Monday, etc.
FUNCTION AfxLocalDayOfWeek () AS WORD
Returns the localized name of the day of the week.
FUNCTION AfxLocalDayOfWeekName (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, BYVAL nYear AS LONG, _
BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| nDay | A number between 1-31. |
| nMonth | A number between 1-12. |
| nYear | A four digit year, e.g. 2011. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the localized short name of the day of the week.
FUNCTION AfxLocalDayOfWeekShortName (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, _
BYVAL nYear AS LONG, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| nDay | A number between 1-31. |
| nMonth | A number between 1-12. |
| nYear | A four digit year, e.g. 2011. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the localized short name of today.
FUNCTION AfxLocalDayShortName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
Returns the current local time as a FILETIME structure.
FUNCTION AfxLocalFileTime () AS FILETIME
Returns the current local hour. The valid values are 0 through 23.
FUNCTION AfxLocalHour () AS WORD
Returns the current local month. The valid values are 1 thorugh 12 (1 = January, etc.).
FUNCTION AfxLocalMonth () AS WORD
Returns the localized name of today's local month.
FUNCTION AfxLocalMonthName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the localized short name of today's local month.
FUNCTION AfxLocalShortMonthName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the current local time as a SYSTEMTIME structure.
FUNCTION AfxLocalSystemTime () AS SYSTEMTIME
Converts a FILETIME to a __time64_t (LONGLONG) value.
FUNCTION AfxLocalTime64 (BYVAL t64 AS LONGLONG) AS tm
| Parameter | Description |
|---|---|
| t64 | A __time64_t (LONGLONG) value. The time is represented as seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC). |
Returns a tm structure. The fields of the returned structure hold the evaluated value of the time argument in UTC rather than in local time.
Retuns the current local time based on the specified mask, e.g. "hh':'mm':'ss".
FUNCTION AfxLocalTimeStr (BYREF wszMask AS WSTRING, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| wszMask | A picture string that is used to form the time. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Picture string used to form the time.
| Picture | Meaning |
|---|---|
| h | Hours with no leading zero for single-digit hours; 12-hour clock |
| hh | Hours with leading zero for single-digit hours; 12-hour clock |
| H | Hours with no leading zero for single-digit hours; 24-hour clock |
| HH | Hours with leading zero for single-digit hours; 24-hour clock |
| m | Minutes with no leading zero for single-digit minutes |
| mm | Minutes with leading zero for single-digit minutes |
| s | Seconds with no leading zero for single-digit seconds |
| ss | Seconds with leading zero for single-digit seconds |
| t | One character time marker string, such as A or P |
| tt | Multi-character time marker string, such as AM or PM |
The formatted time.
Returns the local date and time as a DATE_ (double).
FUNCTION AfxLocalVariantTime () AS DATE_
Returns the current local year. The valid values are 1601 through 30827.
FUNCTION AfxLocalYear () AS WORD
Returns the current date in long format.
FUNCTION AfxLongDate (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Converts the local time to a calendar value.
FUNCTION AfxMakeTime64 (BYREF _tm AS tm) AS LONGLONG
| Parameter | Description |
|---|---|
| tm | A tm structure. |
The fields of the structure type tm store the following values, each of which is an int:
tm_sec : Seconds after minute (0 – 59).
tm_min : Minutes after hour (0 – 59).
tm_hour : Hours after midnight (0 – 23).
tm_mday : Day of month (1 – 31).
tm_mon : Month (0 – 11; January = 0).
tm_year : Year (current year minus 1900).
tm_wday : Day of week (0 – 6; Sunday = 0).
tm_yday : Day of year (0 – 365; January 1 = 0).
tm_isdst : Positive value if daylight saving time is in effect; 0 if daylight saving time is not in effect; negative value if status of daylight saving time is unknown.
The converted time.
Returns the localized name of the specified month.
FUNCTION AfxMonthName (BYVAL nMonth AS LONG, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| nMonth | Valid values are between 1 and 12. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the current date and time as a QUAD (8 bytes). In Free Basic, a QUAD is an ULONGLONG.
FUNCTION AfxQuadDateTime () AS ULONGLONG
Converts a date stored in a QUAD into a formatted date string. For example, to get the date string "Wed, Aug 31 94" use the following picture string: "ddd',' MMM dd yy". In Free Basic, a QUAD is an ULONGLONG.
FUNCTION AfxQuadDateToStr (BYREF wszMask AS WSTRING, BYVAL ullTime AS ULONGLONG, _
BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| wszMask | A picture string that is used to form the date. The format types "d", and "y" must be lowercase and the letter "M" must be uppercase. For example, to get the date string "Wed, Aug 31 94", the application uses the picture string "ddd',' MMM dd yy". |
| ullTime | The datetime variable. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
The formatted date.
Converts a time stored in a QUAD into a formatted time string. For example, get the time string "11:29:40 PM" use the following picture string: "hh':'mm':'ss tt". In Free Basic, a QUAD is an ULONGLONG.
FUNCTION AfxQuadTimeToStr (BYREF wszMask AS WSTRING, BYVAL ullTime AS ULONGLONG, _
BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| wszMask | A picture string that is used to form the time. |
| ullTime | The datetime variable. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Picture string used to form the time.
| Picture | Meaning |
|---|---|
| h | Hours with no leading zero for single-digit hours; 12-hour clock |
| hh | Hours with leading zero for single-digit hours; 12-hour clock |
| H | Hours with no leading zero for single-digit hours; 24-hour clock |
| HH | Hours with leading zero for single-digit hours; 24-hour clock |
| m | Minutes with no leading zero for single-digit minutes |
| mm | Minutes with leading zero for single-digit minutes |
| s | Seconds with no leading zero for single-digit seconds |
| ss | Seconds with leading zero for single-digit seconds |
| t | One character time marker string, such as A or P |
| tt | Multi-character time marker string, such as AM or PM |
The formatted time.
Returns the current date in short format.
FUNCTION AfxShortDate (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the localized short name of the specified month.
FUNCTION AfxShortMonthName (BYVAL nMonth AS LONG, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| nMonth | Valid values are between 1 and 12. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the current system day. The valid values are 1 through 31.
FUNCTION AfxSystemDay () AS WORD
The system time is expressed in Coordinated Universal Time (UTC).
Returns the localized name of today.
FUNCTION AfxSystemDayName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the current day of week. It is a numeric value in the range of 0-6 representing Sunday through Saturday: 0 = Sunday, 1 = Monday, etc.
FUNCTION AfxSystemDayOfWeek () AS WORD
Returns the localized short name of today.
FUNCTION AfxSystemDayShortName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the current system time as a FILETIME structure.
FUNCTION AfxSystemFileTime () AS FILETIME
The system time is expressed in Coordinated Universal Time (UTC).
Returns the current system hour. The valid values are 0 through 23.
FUNCTION AfxSystemHour () AS WORD
The system time is expressed in Coordinated Universal Time (UTC).
Returns the current system month. The valid values are 1 thorugh 12 (1 = January, etc.).
FUNCTION AfxSystemMonth () AS WORD
The system time is expressed in Coordinated Universal Time (UTC).
Returns the localized name of today's system month.
FUNCTION AfxSystemMonthName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the localized short name of today's system month.
FUNCTION AfxSystemShortMonthName (BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Returns the current system time as a SYSTEMTIME structure.
FUNCTION AfxSystemSystemTime () AS SYSTEMTIME
The system time is expressed in Coordinated Universal Time (UTC).
Converts a system time to a __time64_t (LONGLONG).
FUNCTION AfxSystemTimeToTime64 (BYREF st AS SYSTEMTIME) AS LONGLONG
| Parameter | Description |
|---|---|
| st | A SYSTEMTIME structure. |
The converted time.
Converts a SYSTEMTIME type to a string containing the date based on the specified mask, e.g. "dd-MM-yyyy".
FUNCTION AfxSystemTimeToDateStr (BYREF st AS SYSTEMTIME, BYREF wszMask AS WSTRING, _
BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| st | A SYSTEMTIME structure. |
| wszMask | A picture string that is used to form the date. The format types "d", and "y" must be lowercase and the letter "M" must be uppercase. For example, to get the date string "Wed, Aug 31 94", the application uses the picture string "ddd', ' MMM dd yy". |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
The following table defines the format types used to represent days.
| Format type | Meaning |
|---|---|
| d | Day of the month as digits without leading zeros for single-digit days. |
| dd | Day of the month as digits with leading zeros for single-digit days. |
| ddd | Abbreviated day of the week, for example, "Mon" in English (United States). |
| dddd | Day of the week. |
The following table defines the format types used to represent months.
| Format type | Meaning |
|---|---|
| M | Month as digits without leading zeros for single-digit months. |
| MM | Month as digits with leading zeros for single-digit months. |
| MMM | Abbreviated month, for example, "Nov" in English (United States). |
| MMMM | Month value, for example, "November" for English (United States), and "Noviembre" for Spanish (Spain). |
The following table defines the format types used to represent years.
| Format type | Meaning |
|---|---|
| y | Year represented only by the last digit. |
| yy | Year represented only by the last two digits. A leading zero is added for single-digit years. |
| yyyy | Year represented by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed. |
| yyyyy | Behaves identically to "yyyy". |
The formatted date.
Converts a SYSTEMTIME type to a string containing the time based on the specified mask, e.g. "hh':'mm':'ss".
FUNCTION AfxSystemTimeToTimeStr (BYREF st AS SYSTEMTIME, BYREF wszMask AS WSTRING, _
BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| st | A SYSTEMTIME structure. |
| wszMask | A picture string that is used to form the time. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
Picture string used to form the time.
| Picture | Meaning |
|---|---|
| h | Hours with no leading zero for single-digit hours; 12-hour clock |
| hh | Hours with leading zero for single-digit hours; 12-hour clock |
| H | Hours with no leading zero for single-digit hours; 24-hour clock |
| HH | Hours with leading zero for single-digit hours; 24-hour clock |
| m | Minutes with no leading zero for single-digit minutes |
| mm | Minutes with leading zero for single-digit minutes |
| s | Seconds with no leading zero for single-digit seconds |
| ss | Seconds with leading zero for single-digit seconds |
| t | One character time marker string, such as A or P |
| tt | Multi-character time marker string, such as AM or PM |
The formatted time.
Converts a SYSTEMTIME to a DATE_ (double).
FUNCTION AfxSystemTimeToVariantTime (BYREF ST AS SYSTEMTIME) AS DATE_
| Parameter | Description |
|---|---|
| st | A SYSTEMTIME structure. |
The date and time in DATE_ format.
Returns the current system year. The valid values are 1601 through 30827.
FUNCTION AfxSystemYear () AS WORD
The system time is expressed in Coordinated Universal Time (UTC).
Returns the time as seconds elapsed since midnight, January 1, 1970.
FUNCTION AfxTime64 () AS LONGLONG
The current system time as a __time64_t (LONGLONG) value.
Replacement for _time64, not available in msvcrt.dll.
Converts a __time64_t (LONGLONG) value to a FILETIME structure.
FUNCTION AfxTime64ToFileTime (BYVAL t64 AS LONGLONG) AS FILETIME
| Parameter | Description |
|---|---|
| t64 | A __time64_t (LONGLONG) value. The time is represented as seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC). |
The converted time value as FILETIME structure.
Converts a __time64_t (LONGLONG) value to a SYSTEMTIME structure.
FUNCTION AfxTime64ToSystemTime (BYVAL t64 AS LONGLONG) AS SYSTEMTIME
| Parameter | Description |
|---|---|
| t64 | A __time64_t (LONGLONG) value. The time is represented as seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC). |
The converted time value as SYSTEMTIME structure.
Returns the current bias for local time translation. The bias is the difference between Coordinated Universal Time (UTC) and local time. All translations between UTC and local time are based on the following formula: UTC = local time + bias. Units = minutes.
FUNCTION AfxTimeZoneBias () AS LONG
Returns the bias value to be used during local time translations that occur during daylight saving time. This property is ignored if a value for the DaylightDay property is not supplied. The value of this property is added to the Bias property to form the bias used during daylight time. In most time zones, the value of this property is -60. Units = minutes.
FUNCTION AfxTimeZoneDaylightBias () AS LONG
Returns the DaylightDayOfWeek of the DaylightMonth when the transition from standard time to daylight saving time occurs on this operating system.
FUNCTION AfxTimeZoneDaylightDay () AS WORD
Example: If the transition day (DaylightDayOfWeek) occurs on a Sunday, then the value "1" indicates the first Sunday of the DaylightMonth, "2" indicates the second Sunday, and so on. The value "5" indicates the last DaylightDayOfWeek in the month.
Day of the week when the transition from standard time to daylight saving time occurs on an operating system.
FUNCTION AfxTimeZoneDaylightDayOfWeek () AS WORD
The day of the week when the transition from standard time to daylight saving time occurs on an operating system. 0 = Sunday, 1 = Monday, and so on.
Hour of the day when the transition from standard time to daylight saving time occurs on an operating system.
FUNCTION AfxTimeZoneDaylightHour () AS WORD
Minute of the DaylightHour when the transition from standard time to daylight saving time occurs on an operating system.
FUNCTION AfxTimeZoneDaylightMinute () AS WORD
Month when the transition from standard time to daylight saving time occurs on an operating system.
FUNCTION AfxTimeZoneDaylightMonth () AS WORD
The month when the transition from standard time to daylight saving time occurs on an operating system. 1 = January, 2 = February, and so on.
Returns the time zone identifier.
FUNCTION AfxTimeZoneId () AS DWORD
| Value | Description |
|---|---|
| TIME_ZONE_ID_UNKNOWN (0) | Daylight saving time is not used in the current time zone, because there are no transition dates or automatic adjustment for daylight saving time is disabled. |
| TIME_ZONE_ID_STANDARD (1) | The system is operating in the range covered by the StandardDate member of the TIME_ZONE_INFORMATION structure. |
| TIME_ZONE_ID_DAYLIGHT (2) | The system is operating in the range covered by the DaylightDate member of the TIME_ZONE_INFORMATION structure. |
If the function fails for other reasons, such as an out of memory error, it returns TIME_ZONE_ID_INVALID. To get extended error information, call GetLastError.
Returns a description for daylight saving time. For example, "EST" could indicate Eastern Standard Time. This string can be empty.
FUNCTION AfxTimeZoneDaylightName () AS CWSTR
Indicates whether the the system is operating in the range covered by the DaylightDate member of the TIME_ZONE_INFORMATION structure.
FUNCTION AfxTimeZoneIsDaylightSavingTime () AS BOOLEAN
TRUE or FALSE.
Indicates whether the the system is operating in the range covered by the StandardDate member of the TIME_ZONE_INFORMATION structure.
FUNCTION AfxTimeZoneIsStandardSavingTime () AS BOOLEAN
TRUE or FALSE.
Returns the StandardDayOfWeek of the StandardMonth when the transition from daylight saving to standard time occurs on this operating system.
FUNCTION AfxTimeZoneStandardDay () AS WORD
Example: If the transition day (StandardDayOfWeek) occurs on a Sunday, then the value "1" indicates the first Sunday of the StandardMonth, "2" indicates the second Sunday, and so on. The value "5" indicates the last StandardDayOfWeek in the month.
Day of the week when the transition from daylight saving time to standard time occurs on an operating system.
FUNCTION AfxTimeZoneStandardDayOfWeek () AS WORD
The day of the week when the transition from daylight saving time to standard time occurs on an operating system. 0 = Sunday, 1 = Monday, and so on.
Hour of the day when the transition from daylight time saving time to standard time occurs on an operating system.
FUNCTION AfxTimeZoneStandardHour () AS WORD
Minute of the StandardHour when the transition from standard time to daylight saving time occurs on an operating system.
FUNCTION AfxTimeZoneStandardMinute () AS WORD
Month when the transition from daylight saving time to standard time occurs on an operating system.
FUNCTION AfxTimeZoneStandardMonth () AS WORD
The month when the transition from daylight saving time to standard time occurs on an operating system. 1 = January, 2 = February, and so on.
Returns a description for standard time. For example, "EST" could indicate Eastern Standard Time. This string can be empty.
FUNCTION AfxTimeZoneStandardName () AS CWSTR
Converts a DATE_ type to a string.
FUNCTION AfxVariantDateTimeToStr (BYVAL vbDate AS DATE_, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT, _
BYVAL dwFlags AS DWORD = 0) AS CWSTR
| Parameter | Description |
|---|---|
| vbDate | A variant representation of time. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
| dwFlags | Optional. A value made from one or more flags. The following table shows the flags that can be set for this parameter. |
| Flag | Description |
|---|---|
| LOCALE_NOUSEROVERRIDE | Uses the system default locale settings, rather than custom locale settings. |
| VAR_CALENDAR_HJRI | If set then the Hijri calendar is used. Otherwise the calendar sent in Control Panel is used. |
| VAR_DATEVALUEONLY | Omits the time portion of a VT_DATE and retrieves only the date. Applies to conversions to or from dates. Not used for ChangeType and ChangeTypeEx. |
| VAR_TIMEVALUEONLY | Omits the date portion of a VT_DATE and returns only the time. Applies to conversions to or from dates. Not used for ChangeType and ChangeTypeEx. |
The formatted date and time.
Converts a DATE_ type to a string containing only the date
FUNCTION AfxVariantDateToStr (BYVAL vbDate AS DATE_, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| vbDate | A variant representation of time. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
The formatted date.
Converts a DATE_ type to a string containing only the time.
FUNCTION AfxVariantTimeToStr (BYVAL vbDate AS DATE_, BYVAL lcid AS LCID = LOCALE_USER_DEFAULT) AS CWSTR
| Parameter | Description |
|---|---|
| vbDate | A variant representation of time. |
| lcid | Optional. The language identifier used for the conversion. Default is LOCALE_USER_DEFAULT. |
The formatted time.
Converts a DATE_ (double) to a SYSTEMTIME.
FUNCTION AfxVariantTimeToSystemTime (BYVAL dt AS DATE_) AS SYSTEMTIME
| Parameter | Description |
|---|---|
| dt | The DATE_ value. |
The date and time in SYSTEMTIME format.
Returns the week number for a given date. The year must be a 4 digit year.
FUNCTION AfxWeekNumber (BYVAL nDay AS LONG, BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nDay | A day number (1-31). |
| nMonth | A month number (1-12). |
| nYear | A four digit year. |
Returns the first day of the first week of a year. The year must be a 4 digit year.
FUNCTION AfxWeekOne (BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nYear | A four digit year. |
Returns the number of weeks in the specified month. Will be 4 or 5.
FUNCTION AfxWeeksInMonth (BYVAL nMonth AS LONG, BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nMonth | A month number (1-12). |
| nYear | A four digit year. |
Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53.
FUNCTION AfxWeeksInYear (BYVAL nYear AS LONG) AS LONG
| Parameter | Description |
|---|---|
| nYear | A four digit year. |